<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>HttpRESTUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../../../apidocs/org/sakaiproject/entitybus/util/http/HttpRESTUtils.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: HttpRESTUtils.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-utils/xref/org/sakaiproject/entitybus/util/http/HttpRESTUtils.html $</em>
<a name="4" href="#4">4</a>   <em> * HttpUtils.java - entity-broker - Jul 20, 2008 11:42:19 AM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.util.http;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.io.File;
<a name="24" href="#24">24</a>  <strong>import</strong> java.io.IOException;
<a name="25" href="#25">25</a>  <strong>import</strong> java.io.InputStream;
<a name="26" href="#26">26</a>  <strong>import</strong> java.io.UnsupportedEncodingException;
<a name="27" href="#27">27</a>  <strong>import</strong> java.net.URLEncoder;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.HashMap;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.Map;
<a name="30" href="#30">30</a>  <strong>import</strong> java.util.Map.Entry;
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>  <strong>import</strong> javax.servlet.http.Cookie;
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>  <strong>import</strong> org.apache.commons.httpclient.Header;
<a name="35" href="#35">35</a>  <strong>import</strong> org.apache.commons.httpclient.HeaderElement;
<a name="36" href="#36">36</a>  <strong>import</strong> org.apache.commons.httpclient.HttpClient;
<a name="37" href="#37">37</a>  <strong>import</strong> org.apache.commons.httpclient.HttpException;
<a name="38" href="#38">38</a>  <strong>import</strong> org.apache.commons.httpclient.HttpMethod;
<a name="39" href="#39">39</a>  <strong>import</strong> org.apache.commons.httpclient.HttpState;
<a name="40" href="#40">40</a>  <strong>import</strong> org.apache.commons.httpclient.MultiThreadedHttpConnectionManager;
<a name="41" href="#41">41</a>  <strong>import</strong> org.apache.commons.httpclient.cookie.CookiePolicy;
<a name="42" href="#42">42</a>  <strong>import</strong> org.apache.commons.httpclient.methods.ByteArrayRequestEntity;
<a name="43" href="#43">43</a>  <strong>import</strong> org.apache.commons.httpclient.methods.DeleteMethod;
<a name="44" href="#44">44</a>  <strong>import</strong> org.apache.commons.httpclient.methods.EntityEnclosingMethod;
<a name="45" href="#45">45</a>  <strong>import</strong> org.apache.commons.httpclient.methods.FileRequestEntity;
<a name="46" href="#46">46</a>  <strong>import</strong> org.apache.commons.httpclient.methods.GetMethod;
<a name="47" href="#47">47</a>  <strong>import</strong> org.apache.commons.httpclient.methods.InputStreamRequestEntity;
<a name="48" href="#48">48</a>  <strong>import</strong> org.apache.commons.httpclient.methods.PostMethod;
<a name="49" href="#49">49</a>  <strong>import</strong> org.apache.commons.httpclient.methods.PutMethod;
<a name="50" href="#50">50</a>  <strong>import</strong> org.apache.commons.httpclient.methods.RequestEntity;
<a name="51" href="#51">51</a>  <strong>import</strong> org.apache.commons.httpclient.methods.StringRequestEntity;
<a name="52" href="#52">52</a>  <strong>import</strong> org.apache.commons.httpclient.params.HttpMethodParams;
<a name="53" href="#53">53</a>  <strong>import</strong> org.apache.commons.httpclient.protocol.Protocol;
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>  
<a name="56" href="#56">56</a>  <em>/**<em>*</em></em>
<a name="57" href="#57">57</a>  <em> * Utilities for generating and processing http requests,</em>
<a name="58" href="#58">58</a>  <em> * allows the developer to fire off a request and get back information about the response&lt;br/></em>
<a name="59" href="#59">59</a>  <em> * All encoding is automatically UTF-8</em>
<a name="60" href="#60">60</a>  <em> * </em>
<a name="61" href="#61">61</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="62" href="#62">62</a>  <em> */</em>
<a name="63" href="#63">63</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpRESTUtils.html">HttpRESTUtils</a> {
<a name="64" href="#64">64</a>  
<a name="65" href="#65">65</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String CONTENT_TYPE_UTF8 = <span class="string">"text/xml; charset=UTF-8"</span>;
<a name="66" href="#66">66</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ENCODING_UTF8 = <span class="string">"UTF-8"</span>;
<a name="67" href="#67">67</a>      <strong>public</strong> <strong>static</strong> enum Method {POST, GET, PUT, DELETE, HEAD, OPTIONS, TRACE};
<a name="68" href="#68">68</a>  
<a name="69" href="#69">69</a>      <em>/**<em>*</em></em>
<a name="70" href="#70">70</a>  <em>     * Fire off a request to a URL using the specified method,</em>
<a name="71" href="#71">71</a>  <em>     * include optional params and data in the request,</em>
<a name="72" href="#72">72</a>  <em>     * the response data will be returned in the object if the request can be carried out</em>
<a name="73" href="#73">73</a>  <em>     * </em>
<a name="74" href="#74">74</a>  <em>     * @param URL the url to send the request to (absolute or relative, can include query params)</em>
<a name="75" href="#75">75</a>  <em>     * @param method the method to use (e.g. GET, POST, etc.)</em>
<a name="76" href="#76">76</a>  <em>     * @return an object representing the response, includes data about the response</em>
<a name="77" href="#77">77</a>  <em>     * @throws RuntimeException if the request cannot be processed for some reason (this is unrecoverable)</em>
<a name="78" href="#78">78</a>  <em>     */</em>
<a name="79" href="#79">79</a>      <strong>public</strong> <strong>static</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpResponse.html">HttpResponse</a> fireRequest(String URL, Method method) {
<a name="80" href="#80">80</a>          <strong>return</strong> fireRequest(URL, method, <strong>null</strong>, <strong>null</strong>, false);
<a name="81" href="#81">81</a>      }
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em>/**<em>*</em></em>
<a name="84" href="#84">84</a>  <em>     * Fire off a request to a URL using the specified method,</em>
<a name="85" href="#85">85</a>  <em>     * include optional params and data in the request,</em>
<a name="86" href="#86">86</a>  <em>     * the response data will be returned in the object if the request can be carried out</em>
<a name="87" href="#87">87</a>  <em>     * </em>
<a name="88" href="#88">88</a>  <em>     * @param URL the url to send the request to (absolute or relative, can include query params)</em>
<a name="89" href="#89">89</a>  <em>     * @param method the method to use (e.g. GET, POST, etc.)</em>
<a name="90" href="#90">90</a>  <em>     * @param params (optional) params to send along with the request, will be encoded in the query string or in the body depending on the method</em>
<a name="91" href="#91">91</a>  <em>     * @return an object representing the response, includes data about the response</em>
<a name="92" href="#92">92</a>  <em>     * @throws RuntimeException if the request cannot be processed for some reason (this is unrecoverable)</em>
<a name="93" href="#93">93</a>  <em>     */</em>
<a name="94" href="#94">94</a>      <strong>public</strong> <strong>static</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpResponse.html">HttpResponse</a> fireRequest(String URL, Method method, Map&lt;String, String> params) {
<a name="95" href="#95">95</a>          <strong>return</strong> fireRequest(<strong>null</strong>, URL, method, params, <strong>null</strong>, false);
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>  
<a name="98" href="#98">98</a>      <em>/**<em>*</em></em>
<a name="99" href="#99">99</a>  <em>     * Fire off a request to a URL using the specified method,</em>
<a name="100" href="#100">100</a> <em>     * include optional params and data in the request,</em>
<a name="101" href="#101">101</a> <em>     * the response data will be returned in the object if the request can be carried out</em>
<a name="102" href="#102">102</a> <em>     * </em>
<a name="103" href="#103">103</a> <em>     * @param URL the url to send the request to (absolute or relative, can include query params)</em>
<a name="104" href="#104">104</a> <em>     * @param method the method to use (e.g. GET, POST, etc.)</em>
<a name="105" href="#105">105</a> <em>     * @param params (optional) params to send along with the request, will be encoded in the query string or in the body depending on the method</em>
<a name="106" href="#106">106</a> <em>     * @param data (optional) data to send along in the body of the request, this only works for POST and PUT requests, ignored for the other types</em>
<a name="107" href="#107">107</a> <em>     * @param guaranteeSSL if this is true then the request is sent in a mode which will allow self signed certs to work,</em>
<a name="108" href="#108">108</a> <em>     * otherwise https requests will fail if the certs cannot be centrally verified</em>
<a name="109" href="#109">109</a> <em>     * @return an object representing the response, includes data about the response</em>
<a name="110" href="#110">110</a> <em>     * @throws RuntimeException if the request cannot be processed for some reason (this is unrecoverable)</em>
<a name="111" href="#111">111</a> <em>     */</em>
<a name="112" href="#112">112</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpResponse.html">HttpResponse</a> fireRequest(String URL, Method method, Map&lt;String, String> params, Object data, <strong>boolean</strong> guaranteeSSL) {
<a name="113" href="#113">113</a>         <strong>return</strong> fireRequest(<strong>null</strong>, URL, method, params, data, guaranteeSSL);
<a name="114" href="#114">114</a>     }
<a name="115" href="#115">115</a> 
<a name="116" href="#116">116</a>     <em>/**<em>*</em></em>
<a name="117" href="#117">117</a> <em>     * Fire off a request to a URL using the specified method but reuse the client for efficiency,</em>
<a name="118" href="#118">118</a> <em>     * include optional params and data in the request,</em>
<a name="119" href="#119">119</a> <em>     * the response data will be returned in the object if the request can be carried out</em>
<a name="120" href="#120">120</a> <em>     * </em>
<a name="121" href="#121">121</a> <em>     * @param httpClientWrapper (optional) allows the http client to be reused for efficiency,</em>
<a name="122" href="#122">122</a> <em>     * if null a new one will be created each time, use {@link #makeReusableHttpClient(boolean, int)} to</em>
<a name="123" href="#123">123</a> <em>     * create a reusable instance</em>
<a name="124" href="#124">124</a> <em>     * @param URL the url to send the request to (absolute or relative, can include query params)</em>
<a name="125" href="#125">125</a> <em>     * @param method the method to use (e.g. GET, POST, etc.)</em>
<a name="126" href="#126">126</a> <em>     * @param params (optional) params to send along with the request, will be encoded in the query string or in the body depending on the method</em>
<a name="127" href="#127">127</a> <em>     * @param data (optional) data to send along in the body of the request, this only works for POST and PUT requests, ignored for the other types</em>
<a name="128" href="#128">128</a> <em>     * @param guaranteeSSL if this is true then the request is sent in a mode which will allow self signed certs to work,</em>
<a name="129" href="#129">129</a> <em>     * otherwise https requests will fail if the certs cannot be centrally verified</em>
<a name="130" href="#130">130</a> <em>     * @return an object representing the response, includes data about the response</em>
<a name="131" href="#131">131</a> <em>     * @throws RuntimeException if the request cannot be processed for some reason (this is unrecoverable)</em>
<a name="132" href="#132">132</a> <em>     */</em>
<a name="133" href="#133">133</a>     @SuppressWarnings(<span class="string">"deprecation"</span>)
<a name="134" href="#134">134</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpResponse.html">HttpResponse</a> fireRequest(<a href="../../../../../org/sakaiproject/entitybus/util/http/HttpClientWrapper.html">HttpClientWrapper</a> httpClientWrapper, String URL, Method method, Map&lt;String, String> params, Object data, <strong>boolean</strong> guaranteeSSL) {
<a name="135" href="#135">135</a>         <strong>if</strong> (guaranteeSSL) {
<a name="136" href="#136">136</a>             <em class="comment">// added this to attempt to force the SSL self signed certs to work</em>
<a name="137" href="#137">137</a>             Protocol myhttps = <strong>new</strong> Protocol(<span class="string">"https"</span>, <strong>new</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/EasySSLProtocolSocketFactory.html">EasySSLProtocolSocketFactory</a>(), 443);
<a name="138" href="#138">138</a>             Protocol.registerProtocol(<span class="string">"https"</span>, myhttps);
<a name="139" href="#139">139</a>         }
<a name="140" href="#140">140</a> 
<a name="141" href="#141">141</a>         <strong>if</strong> (httpClientWrapper == <strong>null</strong> || httpClientWrapper.getHttpClient() == <strong>null</strong>) {
<a name="142" href="#142">142</a>             httpClientWrapper = makeReusableHttpClient(false, 0, <strong>null</strong>);
<a name="143" href="#143">143</a>         }
<a name="144" href="#144">144</a> 
<a name="145" href="#145">145</a>         HttpMethod httpMethod = <strong>null</strong>;
<a name="146" href="#146">146</a>         <strong>if</strong> (method.equals(Method.GET)) {
<a name="147" href="#147">147</a>             GetMethod gm = <strong>new</strong> GetMethod(URL);
<a name="148" href="#148">148</a>             <em class="comment">// put params into query string</em>
<a name="149" href="#149">149</a>             gm.setQueryString( mergeQueryStringWithParams(gm.getQueryString(), params) );
<a name="150" href="#150">150</a>             <em class="comment">// warn about data being set</em>
<a name="151" href="#151">151</a>             <strong>if</strong> (data != <strong>null</strong>) {
<a name="152" href="#152">152</a>                 System.out.println(<span class="string">"WARN: data cannot be passed in GET requests, data will be ignored (org.sakaiproject.entitybus.util.http.HttpUtils#fireRequest)"</span>);
<a name="153" href="#153">153</a>             }
<a name="154" href="#154">154</a>             httpMethod = gm;
<a name="155" href="#155">155</a>         } <strong>else</strong> <strong>if</strong> (method.equals(Method.POST)) {
<a name="156" href="#156">156</a>             PostMethod pm = <strong>new</strong> PostMethod(URL);
<a name="157" href="#157">157</a>             <em class="comment">// special handling for post params</em>
<a name="158" href="#158">158</a>             <strong>if</strong> (params != <strong>null</strong>) {
<a name="159" href="#159">159</a>                 <strong>for</strong> (Entry&lt;String, String> entry : params.entrySet()) {
<a name="160" href="#160">160</a>                     <strong>if</strong> (entry.getKey() == <strong>null</strong>
<a name="161" href="#161">161</a>                             || entry.getValue() == <strong>null</strong>) {
<a name="162" href="#162">162</a>                         System.out.println(<span class="string">"WARN: null value supplied for param name ("</span>+entry.getKey()+<span class="string">") or value ("</span>
<a name="163" href="#163">163</a>                                 +entry.getValue()+<span class="string">") (org.sakaiproject.entitybus.util.http.HttpUtils#fireRequest)"</span>);
<a name="164" href="#164">164</a>                     }
<a name="165" href="#165">165</a>                     pm.addParameter(entry.getKey(), entry.getValue());
<a name="166" href="#166">166</a>                 }
<a name="167" href="#167">167</a>             }
<a name="168" href="#168">168</a>             <em class="comment">// handle data</em>
<a name="169" href="#169">169</a>             handleRequestData(pm, data);
<a name="170" href="#170">170</a>             httpMethod = pm;
<a name="171" href="#171">171</a>         } <strong>else</strong> <strong>if</strong> (method.equals(Method.PUT)) {
<a name="172" href="#172">172</a>             PutMethod pm = <strong>new</strong> PutMethod(URL);
<a name="173" href="#173">173</a>             <em class="comment">// put params into query string</em>
<a name="174" href="#174">174</a>             pm.setQueryString( mergeQueryStringWithParams(pm.getQueryString(), params) );
<a name="175" href="#175">175</a>             <em class="comment">// handle data</em>
<a name="176" href="#176">176</a>             handleRequestData(pm, data);
<a name="177" href="#177">177</a>             httpMethod = pm;
<a name="178" href="#178">178</a>         } <strong>else</strong> <strong>if</strong> (method.equals(Method.DELETE)) {
<a name="179" href="#179">179</a>             DeleteMethod dm = <strong>new</strong> DeleteMethod(URL);
<a name="180" href="#180">180</a>             <em class="comment">// put params into query string</em>
<a name="181" href="#181">181</a>             dm.setQueryString( mergeQueryStringWithParams(dm.getQueryString(), params) );
<a name="182" href="#182">182</a>             <em class="comment">// warn about data being set</em>
<a name="183" href="#183">183</a>             <strong>if</strong> (data != <strong>null</strong>) {
<a name="184" href="#184">184</a>                 System.out.println(<span class="string">"WARN: data cannot be passed in DELETE requests, data will be ignored (org.sakaiproject.entitybus.util.http.HttpUtils#fireRequest)"</span>);
<a name="185" href="#185">185</a>             }
<a name="186" href="#186">186</a>             httpMethod = dm;
<a name="187" href="#187">187</a>         } <strong>else</strong> {
<a name="188" href="#188">188</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Cannot handle method: "</span> + method);
<a name="189" href="#189">189</a>         }
<a name="190" href="#190">190</a> 
<a name="191" href="#191">191</a>         <em class="comment">// set the standard stuff we use for all requests</em>
<a name="192" href="#192">192</a>         httpMethod.setFollowRedirects(<strong>true</strong>);
<a name="193" href="#193">193</a> 
<a name="194" href="#194">194</a>         <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpResponse.html">HttpResponse</a> response = <strong>null</strong>;
<a name="195" href="#195">195</a>         <strong>try</strong> {
<a name="196" href="#196">196</a>             <strong>int</strong> responseCode = httpClientWrapper.getHttpClient().executeMethod(httpMethod);
<a name="197" href="#197">197</a>             response = <strong>new</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpResponse.html">HttpResponse</a>(responseCode);
<a name="198" href="#198">198</a>             String body = httpMethod.getResponseBodyAsString();
<a name="199" href="#199">199</a>             <em class="comment">//         byte[] responseBody = httpMethod.getResponseBody();</em>
<a name="200" href="#200">200</a>             <em class="comment">//         if (responseBody != null) {</em>
<a name="201" href="#201">201</a>             <em class="comment">//            body = new String(responseBody, "UTF-8");</em>
<a name="202" href="#202">202</a>             <em class="comment">//         }</em>
<a name="203" href="#203">203</a>             response.setResponseBody(body);
<a name="204" href="#204">204</a>             response.setResponseMessage(httpMethod.getStatusText());
<a name="205" href="#205">205</a>             <em class="comment">// now get the headers</em>
<a name="206" href="#206">206</a>             HashMap&lt;String, String[]> responseHeaders = <strong>new</strong> HashMap&lt;String, String[]>();
<a name="207" href="#207">207</a>             Header[] headers = httpMethod.getResponseHeaders();
<a name="208" href="#208">208</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; headers.length; i++) {
<a name="209" href="#209">209</a>                 Header header = headers[i];
<a name="210" href="#210">210</a>                 <em class="comment">// now we convert the headers from these odd pairs into something more like servlets expect</em>
<a name="211" href="#211">211</a>                 HeaderElement[] elements = header.getElements();
<a name="212" href="#212">212</a>                 <strong>if</strong> (elements == <strong>null</strong> || elements.length == 0) {
<a name="213" href="#213">213</a>                     <strong>continue</strong>;
<a name="214" href="#214">214</a>                 } <strong>else</strong> <strong>if</strong> (elements.length >= 1) {
<a name="215" href="#215">215</a>                     String[] values = <strong>new</strong> String[elements.length];
<a name="216" href="#216">216</a>                     StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="217" href="#217">217</a>                     <strong>for</strong> (<strong>int</strong> j = 0; j &lt; elements.length; j++) {
<a name="218" href="#218">218</a>                         sb.setLength(0); <em class="comment">// clear the StringBuilder</em>
<a name="219" href="#219">219</a>                         sb.append(elements[j].getName());
<a name="220" href="#220">220</a>                         <strong>if</strong> (elements[j].getValue() != <strong>null</strong>) {
<a name="221" href="#221">221</a>                             sb.append(<span class="string">"="</span>);
<a name="222" href="#222">222</a>                             sb.append(elements[j].getValue());
<a name="223" href="#223">223</a>                         }
<a name="224" href="#224">224</a>                         values[j] = sb.toString();
<a name="225" href="#225">225</a>                     }
<a name="226" href="#226">226</a>                     responseHeaders.put(header.getName(), values);
<a name="227" href="#227">227</a>                 }
<a name="228" href="#228">228</a>             }
<a name="229" href="#229">229</a>             response.setResponseHeaders(responseHeaders);
<a name="230" href="#230">230</a>         }
<a name="231" href="#231">231</a>         <strong>catch</strong> (HttpException he) {
<a name="232" href="#232">232</a>             <em class="comment">// error contained in he.getMessage()</em>
<a name="233" href="#233">233</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Fatal HTTP Request Error: "</span> +
<a name="234" href="#234">234</a>                     <span class="string">"Could not sucessfully fire request to url ("</span>+URL+<span class="string">") using method ("</span>+method+<span class="string">")  :: "</span> + he.getMessage(), he);
<a name="235" href="#235">235</a>         }
<a name="236" href="#236">236</a>         <strong>catch</strong> (IOException ioe) {
<a name="237" href="#237">237</a>             <em class="comment">// other exception</em>
<a name="238" href="#238">238</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"IOException (transport/connection) Error: "</span> +
<a name="239" href="#239">239</a>                     <span class="string">"Could not sucessfully fire request to url ("</span>+URL+<span class="string">") using method ("</span>+method+<span class="string">")  :: "</span> + ioe.getMessage(), ioe);
<a name="240" href="#240">240</a>         } <strong>finally</strong> {
<a name="241" href="#241">241</a>             httpMethod.releaseConnection();
<a name="242" href="#242">242</a>         }
<a name="243" href="#243">243</a>         <strong>return</strong> response;
<a name="244" href="#244">244</a>     }
<a name="245" href="#245">245</a> 
<a name="246" href="#246">246</a>     <em>/**<em>*</em></em>
<a name="247" href="#247">247</a> <em>     * Merges an existing queryString with a set of params to create one queryString,</em>
<a name="248" href="#248">248</a> <em>     * this basically just adds the params to the end of the existing query string and will not insert a "?"</em>
<a name="249" href="#249">249</a> <em>     * but will take care of the "&amp;"s</em>
<a name="250" href="#250">250</a> <em>     * @param queryString the query string in URL encoded form, without a leading '?'</em>
<a name="251" href="#251">251</a> <em>     * @param params a set of key->value strings to use as params for the request</em>
<a name="252" href="#252">252</a> <em>     * @return the merged queryString with the params included</em>
<a name="253" href="#253">253</a> <em>     */</em>
<a name="254" href="#254">254</a>     <strong>public</strong> <strong>static</strong> String mergeQueryStringWithParams(String queryString, Map&lt;String, String> params) {
<a name="255" href="#255">255</a>         <strong>if</strong> (queryString == <strong>null</strong>) {
<a name="256" href="#256">256</a>             queryString = <span class="string">""</span>;
<a name="257" href="#257">257</a>         }
<a name="258" href="#258">258</a>         <strong>if</strong> (params != <strong>null</strong>) {
<a name="259" href="#259">259</a>             StringBuilder sb = <strong>new</strong> StringBuilder(queryString.trim());
<a name="260" href="#260">260</a>             <strong>for</strong> (Entry&lt;String, String> entry : params.entrySet()) {
<a name="261" href="#261">261</a>                 <strong>if</strong> (sb.length() > 0) {
<a name="262" href="#262">262</a>                     sb.append(<span class="string">"&amp;"</span>);
<a name="263" href="#263">263</a>                 }
<a name="264" href="#264">264</a>                 sb.append( urlEncodeUTF8(entry.getKey()) );
<a name="265" href="#265">265</a>                 sb.append(<span class="string">"="</span>);
<a name="266" href="#266">266</a>                 sb.append( urlEncodeUTF8(entry.getValue()) );
<a name="267" href="#267">267</a>             }
<a name="268" href="#268">268</a>             queryString = sb.toString();
<a name="269" href="#269">269</a>         }
<a name="270" href="#270">270</a>         <strong>return</strong> queryString;
<a name="271" href="#271">271</a>     }
<a name="272" href="#272">272</a> 
<a name="273" href="#273">273</a>     <em>/**<em>*</em></em>
<a name="274" href="#274">274</a> <em>     * Get the query parameters out of a query string and return them as a map,</em>
<a name="275" href="#275">275</a> <em>     * this can be </em>
<a name="276" href="#276">276</a> <em>     * @param urlString a complete URL with query string at the end or a partial URL</em>
<a name="277" href="#277">277</a> <em>     * or just a query string only (e.g. /thing/stuff?blah=1&amp;apple=fruit</em>
<a name="278" href="#278">278</a> <em>     * @return the map of all query string parameters (e.g. blah => 1, apple => fruit)</em>
<a name="279" href="#279">279</a> <em>     */</em>
<a name="280" href="#280">280</a>     <strong>public</strong> <strong>static</strong> Map&lt;String, String> parseURLintoParams(String urlString) {
<a name="281" href="#281">281</a>         <strong>if</strong> (urlString == <strong>null</strong>) {
<a name="282" href="#282">282</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"URLstring must not be null"</span>);
<a name="283" href="#283">283</a>         }
<a name="284" href="#284">284</a>         Map&lt;String, String> map = <strong>new</strong> HashMap&lt;String, String>();
<a name="285" href="#285">285</a>         <em class="comment">// first reduce it to everything after the ?</em>
<a name="286" href="#286">286</a>         <strong>int</strong> questionLoc = urlString.indexOf('?');
<a name="287" href="#287">287</a>         <strong>if</strong> (questionLoc >= 0) {
<a name="288" href="#288">288</a>             <strong>if</strong> (questionLoc+1 &lt; urlString.length()) {
<a name="289" href="#289">289</a>                 urlString = urlString.substring(questionLoc+1);
<a name="290" href="#290">290</a>             }
<a name="291" href="#291">291</a>         }
<a name="292" href="#292">292</a>         <em class="comment">// next make sure we have at least one param</em>
<a name="293" href="#293">293</a>         <strong>if</strong> (urlString.indexOf('=') > 0) {
<a name="294" href="#294">294</a>             String[] params = urlString.split(<span class="string">"&amp;"</span>);
<a name="295" href="#295">295</a>             <strong>for</strong> (String param : params) {
<a name="296" href="#296">296</a>                 <strong>int</strong> eqLoc = param.indexOf('=');
<a name="297" href="#297">297</a>                 <strong>if</strong> (eqLoc > 0 
<a name="298" href="#298">298</a>                         &amp;&amp; eqLoc &lt; param.length()) {
<a name="299" href="#299">299</a>                     String name = param.substring(0, eqLoc);
<a name="300" href="#300">300</a>                     String value = param.substring(eqLoc+1);
<a name="301" href="#301">301</a>                     map.put(name, value);
<a name="302" href="#302">302</a>                 }
<a name="303" href="#303">303</a>             }
<a name="304" href="#304">304</a>         }
<a name="305" href="#305">305</a>         <strong>return</strong> map;
<a name="306" href="#306">306</a>     }
<a name="307" href="#307">307</a> 
<a name="308" href="#308">308</a>     <strong>protected</strong> <strong>static</strong> String urlEncodeUTF8(String toEncode) {
<a name="309" href="#309">309</a>         String encoded = <strong>null</strong>;
<a name="310" href="#310">310</a>         <strong>if</strong> (toEncode != <strong>null</strong>) {
<a name="311" href="#311">311</a>             <strong>try</strong> {
<a name="312" href="#312">312</a>                 encoded = URLEncoder.encode(toEncode, ENCODING_UTF8);
<a name="313" href="#313">313</a>             } <strong>catch</strong> (UnsupportedEncodingException e) {
<a name="314" href="#314">314</a>                 <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Encoding to URL using UTF8 failed for: "</span> + toEncode + <span class="string">" :: "</span> + e.getMessage(), e);
<a name="315" href="#315">315</a>             }
<a name="316" href="#316">316</a>         }
<a name="317" href="#317">317</a>         <strong>return</strong> encoded;
<a name="318" href="#318">318</a>     }
<a name="319" href="#319">319</a> 
<a name="320" href="#320">320</a>     <strong>protected</strong> <strong>static</strong> <strong>void</strong> handleRequestData(EntityEnclosingMethod method, Object data) {
<a name="321" href="#321">321</a>         <strong>if</strong> (method == <strong>null</strong>) {
<a name="322" href="#322">322</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid method, cannot be null"</span>);
<a name="323" href="#323">323</a>         }
<a name="324" href="#324">324</a>         <strong>if</strong> (data != <strong>null</strong>) {
<a name="325" href="#325">325</a>             RequestEntity re = <strong>null</strong>;
<a name="326" href="#326">326</a>             <strong>if</strong> (data.getClass().isAssignableFrom(InputStream.<strong>class</strong>)) {
<a name="327" href="#327">327</a>                 re = <strong>new</strong> InputStreamRequestEntity((InputStream) data, CONTENT_TYPE_UTF8);
<a name="328" href="#328">328</a>             } <strong>else</strong> <strong>if</strong> (data.getClass().isAssignableFrom(byte[].<strong>class</strong>)) {
<a name="329" href="#329">329</a>                 re = <strong>new</strong> ByteArrayRequestEntity((byte[]) data, CONTENT_TYPE_UTF8);
<a name="330" href="#330">330</a>             } <strong>else</strong> <strong>if</strong> (data.getClass().isAssignableFrom(File.<strong>class</strong>)) {
<a name="331" href="#331">331</a>                 re = <strong>new</strong> FileRequestEntity((File) data, CONTENT_TYPE_UTF8);
<a name="332" href="#332">332</a>             } <strong>else</strong> {
<a name="333" href="#333">333</a>                 <em class="comment">// handle as a string</em>
<a name="334" href="#334">334</a>                 <strong>try</strong> {
<a name="335" href="#335">335</a>                     re = <strong>new</strong> StringRequestEntity(data.toString(), <span class="string">"text/xml"</span>, ENCODING_UTF8);
<a name="336" href="#336">336</a>                 } <strong>catch</strong> (UnsupportedEncodingException e) {
<a name="337" href="#337">337</a>                     <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"Encoding data using UTF8 failed :: "</span> + e.getMessage(), e);
<a name="338" href="#338">338</a>                 }
<a name="339" href="#339">339</a>             }
<a name="340" href="#340">340</a>             method.setRequestEntity(re);
<a name="341" href="#341">341</a>         }
<a name="342" href="#342">342</a>     }
<a name="343" href="#343">343</a> 
<a name="344" href="#344">344</a>     <em>/**<em>*</em></em>
<a name="345" href="#345">345</a> <em>     * Parses a url string into component pieces,</em>
<a name="346" href="#346">346</a> <em>     * unlike the java URL class, this will work with partial urls</em>
<a name="347" href="#347">347</a> <em>     * @param urlString any URL string</em>
<a name="348" href="#348">348</a> <em>     * @return the URL data object</em>
<a name="349" href="#349">349</a> <em>     */</em>
<a name="350" href="#350">350</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/URLData.html">URLData</a> parseURL(String urlString) {
<a name="351" href="#351">351</a>         <strong>return</strong> <strong>new</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/URLData.html">URLData</a>(urlString);
<a name="352" href="#352">352</a>     }
<a name="353" href="#353">353</a> 
<a name="354" href="#354">354</a>     <em>/**<em>*</em></em>
<a name="355" href="#355">355</a> <em>     * Turns a method string ("get") into a {@link Method} enum object</em>
<a name="356" href="#356">356</a> <em>     * @param method a method string (case is not important) e.g. GET, Post, put, DeLeTe</em>
<a name="357" href="#357">357</a> <em>     * @return the corresponding {@link Method} enum</em>
<a name="358" href="#358">358</a> <em>     */</em>
<a name="359" href="#359">359</a>     <strong>public</strong> <strong>static</strong> Method makeMethodFromString(String method) {
<a name="360" href="#360">360</a>         Method m;
<a name="361" href="#361">361</a>         <strong>if</strong> (method == <strong>null</strong> || <span class="string">""</span>.equals(method)) {
<a name="362" href="#362">362</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"method cannot be null"</span>);
<a name="363" href="#363">363</a>         }
<a name="364" href="#364">364</a>         <strong>if</strong> (method.equalsIgnoreCase(<span class="string">"GET"</span>)) {
<a name="365" href="#365">365</a>             m = Method.GET;
<a name="366" href="#366">366</a>         } <strong>else</strong> <strong>if</strong> (method.equalsIgnoreCase(<span class="string">"POST"</span>)) {
<a name="367" href="#367">367</a>             m = Method.POST;
<a name="368" href="#368">368</a>         } <strong>else</strong> <strong>if</strong> (method.equalsIgnoreCase(<span class="string">"PUT"</span>)) {
<a name="369" href="#369">369</a>             m = Method.PUT;
<a name="370" href="#370">370</a>         } <strong>else</strong> <strong>if</strong> (method.equalsIgnoreCase(<span class="string">"DELETE"</span>)) {
<a name="371" href="#371">371</a>             m = Method.DELETE;
<a name="372" href="#372">372</a>         } <strong>else</strong> <strong>if</strong> (method.equalsIgnoreCase(<span class="string">"HEAD"</span>)) {
<a name="373" href="#373">373</a>             m = Method.HEAD;
<a name="374" href="#374">374</a>         } <strong>else</strong> <strong>if</strong> (method.equalsIgnoreCase(<span class="string">"OPTIONS"</span>)) {
<a name="375" href="#375">375</a>             m = Method.OPTIONS;
<a name="376" href="#376">376</a>         } <strong>else</strong> <strong>if</strong> (method.equalsIgnoreCase(<span class="string">"TRACE"</span>)) {
<a name="377" href="#377">377</a>             m = Method.TRACE;
<a name="378" href="#378">378</a>         } <strong>else</strong> {
<a name="379" href="#379">379</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Unknown http method type ("</span>+method+<span class="string">"): should be GET, POST, PUT, DELETE, HEAD, OPTIONS, or TRACE"</span>);
<a name="380" href="#380">380</a>         }
<a name="381" href="#381">381</a>         <strong>return</strong> m;
<a name="382" href="#382">382</a>     }
<a name="383" href="#383">383</a> 
<a name="384" href="#384">384</a>     <em>/**<em>*</em></em>
<a name="385" href="#385">385</a> <em>     * Generates a reusable http client wrapper which can be given to {@link #fireRequest(HttpClientWrapper, String, Method, Map, Object, boolean)}</em>
<a name="386" href="#386">386</a> <em>     * as an efficiency mechanism</em>
<a name="387" href="#387">387</a> <em>     * </em>
<a name="388" href="#388">388</a> <em>     * @param multiThreaded true if you want to allow the client to run in multiple threads</em>
<a name="389" href="#389">389</a> <em>     * @param idleConnectionTimeout if this is 0 then it will use the defaults, otherwise connections will be timed out after this long (ms)</em>
<a name="390" href="#390">390</a> <em>     * @param cookies to send along with every request from this client</em>
<a name="391" href="#391">391</a> <em>     * @return the reusable http client wrapper</em>
<a name="392" href="#392">392</a> <em>     */</em>
<a name="393" href="#393">393</a>     <strong>public</strong> <strong>static</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpClientWrapper.html">HttpClientWrapper</a> makeReusableHttpClient(<strong>boolean</strong> multiThreaded, <strong>int</strong> idleConnectionTimeout, Cookie[] cookies) {
<a name="394" href="#394">394</a>         <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpClientWrapper.html">HttpClientWrapper</a> wrapper;
<a name="395" href="#395">395</a>         HttpClient client;
<a name="396" href="#396">396</a>         MultiThreadedHttpConnectionManager connectionManager = <strong>null</strong>;
<a name="397" href="#397">397</a>         <strong>if</strong> (multiThreaded) {
<a name="398" href="#398">398</a>             connectionManager = <strong>new</strong> MultiThreadedHttpConnectionManager();
<a name="399" href="#399">399</a>             client = <strong>new</strong> HttpClient(connectionManager);
<a name="400" href="#400">400</a>         } <strong>else</strong> {
<a name="401" href="#401">401</a>             client = <strong>new</strong> HttpClient();
<a name="402" href="#402">402</a>         }
<a name="403" href="#403">403</a>         <strong>if</strong> (idleConnectionTimeout &lt;= 0) {
<a name="404" href="#404">404</a>             idleConnectionTimeout = 5000;
<a name="405" href="#405">405</a>         }
<a name="406" href="#406">406</a>         client.getHttpConnectionManager().closeIdleConnections(idleConnectionTimeout);
<a name="407" href="#407">407</a>         client.getHttpConnectionManager().getParams().setConnectionTimeout(idleConnectionTimeout);
<a name="408" href="#408">408</a>         <em class="comment">// create the initial state</em>
<a name="409" href="#409">409</a>         HttpState initialState = <strong>new</strong> HttpState();
<a name="410" href="#410">410</a>         <strong>if</strong> (cookies != <strong>null</strong> &amp;&amp; cookies.length > 0) {
<a name="411" href="#411">411</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; cookies.length; i++) {
<a name="412" href="#412">412</a>                 Cookie c = cookies[i];
<a name="413" href="#413">413</a>                 org.apache.commons.httpclient.Cookie mycookie = 
<a name="414" href="#414">414</a>                     <strong>new</strong> org.apache.commons.httpclient.Cookie(c.getDomain(), c.getName(), c.getValue(), c.getPath(), c.getMaxAge(), c.getSecure());
<a name="415" href="#415">415</a>                 initialState.addCookie(mycookie);
<a name="416" href="#416">416</a>             }
<a name="417" href="#417">417</a>             client.setState(initialState);
<a name="418" href="#418">418</a>         }
<a name="419" href="#419">419</a>         <em class="comment">// set some defaults</em>
<a name="420" href="#420">420</a>         client.getParams().setParameter(HttpMethodParams.USER_AGENT, <span class="string">"Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.9.0.1) Gecko/2008070208 Firefox/3.0.1"</span>);
<a name="421" href="#421">421</a>         client.getParams().setCookiePolicy(CookiePolicy.BROWSER_COMPATIBILITY);
<a name="422" href="#422">422</a>         client.getParams().setBooleanParameter(HttpMethodParams.SINGLE_COOKIE_HEADER, <strong>true</strong>);
<a name="423" href="#423">423</a>         wrapper = <strong>new</strong> <a href="../../../../../org/sakaiproject/entitybus/util/http/HttpClientWrapper.html">HttpClientWrapper</a>(client, connectionManager, initialState);
<a name="424" href="#424">424</a>         <strong>return</strong> wrapper;
<a name="425" href="#425">425</a>     }
<a name="426" href="#426">426</a> 
<a name="427" href="#427">427</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

